Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

link directly to new supplemental guidance #2296

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

shawna-slh
Copy link
Contributor

@shawna-slh shawna-slh commented Apr 2, 2022

Copy link

netlify bot commented Oct 21, 2024

Deploy Preview for wcag2 failed.

Name Link
🔨 Latest commit 1e590d8
🔍 Latest deploy log https://app.netlify.com/sites/wcag2/deploys/672f70fe2217310008900982

@kfranqueiro kfranqueiro self-requested a review October 21, 2024 17:15
Copy link
Contributor

@dbjorge dbjorge left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@bruce-usab
Copy link
Contributor

Discussed on backlog call, add to CFC.

@patrickhlauke patrickhlauke changed the title link directly to new supplmental guidance link directly to new supplemental guidance Nov 8, 2024
@bruce-usab
Copy link
Contributor

Discussed on TF call 11/8, might be OBE. @kfranqueiro will check in again with @shawna-slh

Co-authored-by: Mike Gower <mikegower@gmail.com>
@shawna-slh
Copy link
Contributor Author

/me looks up OBE ... officer (of the Order) of the British Empire / Order of the British Empire ... out-of-body experience ... overcome / overtaken by events

After revision this PR now:

  1. changes the link directly to the Supplemental Guidance About page, which includes important context such as "Following this guidance is not required to meet WCAG. And, we encourage you to follow this guidance in order meet more user needs."
  • the current link would take them 3 steps to get there (which is on purpose for other use cases, but would be bad for this use case... though we could add a new section just for this use case if there is a reason not to update the link...)
  • if it's better to make a bit less of a change, the link could include the rest of the phrase: <a href="https://www.w3.org/WAI/WCAG2/supplemental/about/">supplemental guidance on improving inclusion for people with disabilities, including cognitive and learning disabilities, low vision, and more</a>.
  1. fixes sentence structure and PWD terminology

Neither are dangerously wrong if not fixed. I happily leave it to others to determine the appropriateness for this change or not. :)

fyi brief history: we planned to do something like 'supplemental guidance' but didn't know if we would end up calling it that. the link used to go to a section in WCAG 2 Overview that explained that some kind of supplemental guidance was coming. after it existed and when we updated WCAG 2 Overview and The WCAG 2 Documents, that was changed. (to be honest, we forgot about the link from WCAG)

@shawna-slh
Copy link
Contributor Author

related comment that gets hidden in resolved thread:

alastc
There was (and is) and agreement to link to the COGA supplemental guidance, but I think that's taken care of in the "Layers of guidance" section in WCAG.

shawna-slh
Ah, I didn't realize that a link to [Making Content Usable for People with Cognitive and Learning Disabilities] had been added to that section (last paragraph).
Is it too late to fix the sentence structure? (especially since it's about cognitive disabilities, the irony is unfortunate :) @iadawn fyi

Should we create a new issue for fixing that sentence structure? Or should I just let it go? (I'm fine doing either.)

@mbgower
Copy link
Contributor

mbgower commented Nov 15, 2024

Should we create a new issue for fixing that sentence structure? Or should I just let it go? (I'm fine doing either.)

@shawna-slh If you want to fix it, create a new issue, otherwise you can just let it go :)

@mbgower mbgower added ErratumRaised Potential erratum for a Recommendation and removed Normative labels Nov 21, 2024
@mbgower
Copy link
Contributor

mbgower commented Nov 21, 2024

I removed the Normative label since this is clearly part of the introduction and is clearly marked as being non-normative.
image

@detlevhfischer
Copy link
Contributor

detlevhfischer commented Nov 21, 2024

One probably minor problem is that the link promises more than the page linked to can hold. There is, for example, currently no low vision guidance. May suggest adapting the link text.

@WilcoFiers
Copy link
Contributor

I don't think this is worth publishing an errata for. Don't forget that this link will forever be in use in all the thousands of copies that exist of WCAG, including the W3C's own translations of WCAG.

@shawna-slh
Copy link
Contributor Author

including the W3C's own translations of WCAG.

just fyi, we are pursuing updates of WCAG translations when appropriate

@bruce-usab
Copy link
Contributor

Discussed on TF call 11/22 and all parties satisfied that we have correct link and that this can be included with republication.

@mbgower
Copy link
Contributor

mbgower commented Nov 22, 2024

Discussed on TF call 11/22 and all parties satisfied that we have correct link and that this can be included with republication.

In the context of this PR, we agreed that this is non-normative and so can be addressed through errata; in fact, that it does not require a republication or CFC process.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Editorial ErratumRaised Potential erratum for a Recommendation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

10 participants